Skip to main content
GET
Get one Delivery

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

type
enum<string>
required

Specify the delivery type to which your operations will be restricted.

Available options:
asn,
rma,
other
id
integer<int32>
required

The id of the referenced Delivery.

Required range: x >= 1

Query Parameters

fields
enum<string>[]

Specify additional fields of the ASN OR RMA object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
customer_name,
carrier_name,
authorized_at,
delivered_at,
receive_by,
processed_at,
putaway_at,
completed_at,
ready_to_process_at,
merchant_rma_number,
merchant_status,
carrier_tracking_number,
merchant_order_number,
item_count,
container_count,
label_count,
exception_count,
processing_comments,
special_requirements,
is_auto_commit,
order,
created_at,
updated_at,
supplier_name,
expected_at,
merchant_reference,
supplier_invoice_reference,
supplier_order_reference,
shipment_type,
bill_of_lading,
tracking_numbers,
standard_carrier_alpha_code,
status_history,
items
fields:merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
created_at,
updated_at,
brands,
default_brand,
custom_fields
fields:warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response.

Available options:
basic,
all,
id,
name,
is_active,
abbreviation
fields:status_history
enum<string>[]

Specify additional fields of the DeliveryStatusHistory object to be included in the response. See the selecting fields page for more information.

Available options:
all,
delivery_item,
status,
exception,
exception_status,
comment,
user,
created_at,
package
fields:items
enum<string>[]

Specify additional fields of the DeliveryItem objects to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
product,
quantity,
qty_expected,
qty_received,
qty_shortage,
qty_overage,
qty_processed,
qty_putaway,
qty_committed,
qty_returned,
is_sku_merge_email_sent,
lots,
locations,
exceptions
fields:items.exceptions
enum<string>[]

Specify additional fields of the DeliveryException objects nested under items to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
container,
lot,
status,
sign,
reason,
comment,
quantity
fields:items.lots
enum<string>[]

Specify additional fields of the DeliveryItemLot objects nested under items to be included in the response. See the selecting fields page for more information.

Available options:
all,
lot,
qty_counted,
qty_putaway
fields:items.locations
enum<string>[]

Specify additional fields of the DeliveryItemLocation objects nested under items to be included in the response. See the selecting fields page for more information.

Available options:
all,
location,
qty_putaway,
qty_committed
fields:containers
enum<string>[]

Specify additional fields of the DeliveryContainer objects to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
label,
type,
status,
weight,
length,
width,
height,
total_skus,
total_qty,
contents

Response

OK

resource
ASN · object

An ASN (Advanced Shipping Notification) delivery object.

included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.